.. _`Predict`:

.. _`org.sysess.sympathy.machinelearning.predict`:

Predict
```````

.. image:: predict.svg
   :width: 48


Uses a model to predict Y given X




Documentation
:::::::::::::

Applies a model to data. Uses the models implementation of the .predict method to predict Y
given X. If the model was trained, X must be in the same format as the train data. (Note that
some advanced models will not work with this node but must be used with the Predict Dataset
node.)


Definition
::::::::::


Input ports
...........

    **in-model**
        | Type: model
        | Description: Input model
    **X**
        | Type: table
        | Description: X

Output ports
............

    **Y**
        | Type: table
        | Description: Y



Configuration
.............

    **Pass through X** (pass_x)
        Passes through a copy of X in addition to the predicted values







Examples
........





The node can be found in:

* :download:`Regression.syx </Examples/Sympathy for Data/MachineLearning/Regression.syx>`

* :download:`Metrics.syx </Examples/Sympathy for Data/MachineLearning/Metrics.syx>`

* :download:`Text_Classification.syx </Examples/Sympathy for Data/MachineLearning/Text_Classification.syx>`

* :download:`MNIST_Digits.syx </Examples/Sympathy for Data/MachineLearning/MNIST_Digits.syx>`

* :download:`Eigenfaces.syx </Examples/Sympathy for Data/MachineLearning/Eigenfaces.syx>`

* :download:`Object_recognition_by_features.syx </Examples/Sympathy for Data/ImageProcessing/Object_recognition_by_features.syx>`

* :download:`Fisher_faces.syx </Examples/Advanced Machine Learning/Fisher_faces.syx>`

* :download:`clustering.syx </Examples/Advanced Machine Learning/clustering.syx>`

* :download:`KmeansOutlierRemoval.syx </Examples/Advanced Machine Learning/KmeansOutlierRemoval.syx>`

* :download:`random_forest_regressor.syx </Examples/Advanced Machine Learning/random_forest_regressor.syx>`




Implementation
..............

.. automodule:: node_application
    :noindex:

.. class:: Predict
    :noindex: